Message Box
AutomatR.DefaultActivities.Applications.MessageBox
The "Message Box" activity in AutomatR displays a message box with specified text, title, buttons, and icon. This activity is useful for interacting with users during the execution of an automation workflow.
Properties
| Name | Description |
|---|---|
| Input | |
| Buttons | Specifies the buttons to be displayed on the message box. Choose from options like "OK," "Yes/No," "Retry/Cancel," etc. Enumerated value: MessageBoxButtonsCustom. |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Message Box" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Icon | Specifies the icon to be displayed on the message box. Choose from options like "Information," "Warning," "Error," etc. Enumerated value: MessageBoxIconsCustom. |
| Message | Specifies the text to be displayed in the message box. String variables containing the message text. |
| Title | Specifies the title of the message box. String variables containing the title text. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. Enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Message Box" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Message Box" operation, indicating which button the user chose during runtime. String variables containing the chosen button. Possible values: "Yes," "No," "Cancel," "OK," "Abort," "Ignore," "Retry," or "None" if no button is selected. |
How to use:
- Drag and drop the "Message Box" activity onto the workflow.
- Configure the properties by specifying the message text, title, buttons, and icon for the message box.
- Optionally, configure the delay for synchronization purposes.
- Execute the workflow to display the message box with the specified configuration.
Example: Consider an example where the "Message Box" activity is used to display a warning message:
Message Box:
Delay: 1
Title: "Warning"
Message: "This action cannot be undone. Do you want to proceed?"
Buttons: YesNo
Icon: Warning
Result: userChoice
In this example, the activity displays a message box titled "Warning" with the specified message, "This action cannot be undone. Do you want to proceed?" The message box includes "Yes" and "No" buttons, and the user's choice is stored in the string variable userChoice for further handling in the workflow.